package org.easySpace.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author lzh@aginome.com
 * @description swagger配置文件
 * @date 2022-06-01 11:47 AM
 */




@Configuration
@EnableOpenApi
public class SwaggerConfig {

    @Value("${swagger.enabled}")
    private boolean enableSwagger;

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo()).enable(enableSwagger)
                // 允许忽略预定义的响应消息默认值
                .useDefaultResponseMessages(false)
                .select()
                /*
                 * 通过apis方法，basePackage可以根据包路径来生成特定类的API
                 * any方法是默认所有都有效，
                 * none方法都无效；
                 * withClassAnnotation根据类注解，withMethodAnnotation是根据方法注解；一般我们用的是 basePackage方法
                 */
                .apis(RequestHandlerSelectors.basePackage("org.easySpace.controller"))
                /*
                 * 根据请求路径的paths方法
                 *  1.ant匹配路径
                 *  2.any是匹配任意路径
                 *  3.none是都不匹配
                 *  4.regex是正则匹配
                 */
                .paths(PathSelectors.any())
                .build()
                .enable(enableSwagger);
    }


    /**
     * 文档描述信息
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("cbio 接口文档")
                .description("cbio接口描述")
                .version("1.0")
                .build();
    }


}
